1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
#![allow(non_camel_case_types, non_snake_case)]
use crate::co;
use crate::decl::*;
use crate::guard::*;
use crate::kernel::{ffi, privs::*};
use crate::prelude::*;
impl_handle! { HFILE;
/// Handle to a
/// [file](https://learn.microsoft.com/en-us/windows/win32/winprog/windows-data-types#hfile).
/// Originally just a `HANDLE`.
///
/// Unless you need something specific, consider using the
/// [`File`](crate::File) high-level abstraction.
}
impl kernel_Hfile for HFILE {}
/// This trait is enabled with the `kernel` feature, and provides methods for
/// [`HFILE`](crate::HFILE).
///
/// Prefer importing this trait through the prelude:
///
/// ```no_run
/// use winsafe::prelude::*;
/// ```
pub trait kernel_Hfile: Handle {
/// [`CreateFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilew)
/// function.
///
/// The error code is also returned because it can carry information even if
/// the file is successfully open.
///
/// Unless you need something specific, consider using the
/// [`File`](crate::File) high-level abstraction.
///
/// # Examples
///
/// Opening an existing file as read-only:
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, co};
///
/// let (hfile, status) = w::HFILE::CreateFile(
/// "C:\\Temp\\test.txt",
/// co::GENERIC::READ,
/// Some(co::FILE_SHARE::READ),
/// None,
/// co::DISPOSITION::OPEN_EXISTING,
/// co::FILE_ATTRIBUTE::NORMAL,
/// None,
/// None,
/// None,
/// )?;
/// # w::SysResult::Ok(())
/// ```
///
/// Opening a file for read and write. If the file doesn't exist, create it:
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, co};
///
/// let (hfile, status) = w::HFILE::CreateFile(
/// "C:\\Temp\\test.txt",
/// co::GENERIC::READ | co::GENERIC::WRITE,
/// None,
/// None,
/// co::DISPOSITION::OPEN_ALWAYS,
/// co::FILE_ATTRIBUTE::NORMAL,
/// None,
/// None,
/// None,
/// )?;
/// # w::SysResult::Ok(())
/// ```
#[must_use]
fn CreateFile(
file_name: &str,
desired_access: co::GENERIC,
share_mode: Option<co::FILE_SHARE>,
security_attributes: Option<&mut SECURITY_ATTRIBUTES>,
creation_disposition: co::DISPOSITION,
attributes: co::FILE_ATTRIBUTE,
flags: Option<co::FILE_FLAG>,
security: Option<co::FILE_SECURITY>,
hfile_template: Option<&HFILE>,
) -> SysResult<(CloseHandleGuard<HFILE>, co::ERROR)>
{
unsafe {
match HFILE(
ffi::CreateFileW(
WString::from_str(file_name).as_ptr(),
desired_access.raw(),
share_mode.unwrap_or_default().raw(),
security_attributes.map_or(std::ptr::null_mut(), |lp| lp as *mut _ as _),
creation_disposition.raw(),
attributes.raw()
| flags.unwrap_or_default().raw()
| security.map_or(0, |s| SECURITY_SQOS_PRESENT | s.raw()),
hfile_template.map_or(std::ptr::null_mut(), |h| h.ptr()),
) as _,
) {
HFILE::NULL | HFILE::INVALID => Err(GetLastError()),
handle => Ok((CloseHandleGuard::new(handle), GetLastError())),
}
}
}
/// [`CreateFileMapping`](https://learn.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-createfilemappingw)
/// function.
///
/// Unless you need something specific, consider using the
/// [`FileMapped`](crate::FileMapped) high-level abstraction.
#[must_use]
fn CreateFileMapping(&self,
mapping_attrs: Option<&mut SECURITY_ATTRIBUTES>,
protect: co::PAGE,
max_size: Option<u64>,
mapping_name: Option<&str>,
) -> SysResult<CloseHandleGuard<HFILEMAP>>
{
unsafe {
ptr_to_sysresult_handle(
ffi::CreateFileMappingFromApp(
self.ptr(),
mapping_attrs.map_or(std::ptr::null_mut(), |lp| lp as *mut _ as _),
protect.raw(),
max_size.unwrap_or_default(),
WString::from_opt_str(mapping_name).as_ptr(),
),
).map(|h| CloseHandleGuard::new(h))
}
}
/// [`GetFileInformationByHandle`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfileinformationbyhandle)
/// function.
fn GetFileInformationByHandle(&self,
fi: &mut BY_HANDLE_FILE_INFORMATION,
) -> SysResult<()>
{
bool_to_sysresult(
unsafe {
ffi::GetFileInformationByHandle(self.ptr(), fi as *mut _ as _)
},
)
}
/// [`GetFileSizeEx`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfilesizeex)
/// function.
#[must_use]
fn GetFileSizeEx(&self) -> SysResult<u64> {
let mut sz_buf = i64::default();
bool_to_sysresult(unsafe { ffi::GetFileSizeEx(self.ptr(), &mut sz_buf) })
.map(|_| sz_buf as _)
}
/// [`GetFileTime`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfiletime)
/// function.
fn GetFileTime(&self,
creation_time: Option<&mut FILETIME>,
last_access_time: Option<&mut FILETIME>,
last_write_time: Option<&mut FILETIME>,
) -> SysResult<()>
{
bool_to_sysresult(
unsafe {
ffi::GetFileTime(
self.ptr(),
creation_time.map_or(std::ptr::null_mut(), |p| p as * mut _ as _),
last_access_time.map_or(std::ptr::null_mut(), |p| p as * mut _ as _),
last_write_time.map_or(std::ptr::null_mut(), |p| p as * mut _ as _),
)
},
)
}
/// [`GetFileType`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfiletype)
/// function.
#[must_use]
fn GetFileType(&self) -> SysResult<co::FILE_TYPE> {
match unsafe { co::FILE_TYPE::from_raw(ffi::GetFileType(self.ptr())) } {
co::FILE_TYPE::UNKNOWN => match GetLastError() {
co::ERROR::SUCCESS => Ok(co::FILE_TYPE::UNKNOWN), // actual unknown type
err => Err(err),
},
ty => Ok(ty),
}
}
/// [`LockFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfile)
/// function.
///
/// In the original C implementation, you must call
/// [`UnlockFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-unlockfile)
/// as a cleanup operation.
///
/// Here, the cleanup is performed automatically, because `LockFile` returns
/// an [`UnlockFileGuard`](crate::guard::UnlockFileGuard), which
/// automatically calls `UnlockFile` when the guard goes out of scope. You
/// must, however, keep the guard alive, otherwise the cleanup will be
/// performed right away.
///
/// # Examples
///
/// ```no_run
/// use winsafe::{self as w, prelude::*};
///
/// let hfile: w::HFILE; // initialized somewhere
/// # let hfile = w::HFILE::NULL;
///
/// let total_size = hfile.GetFileSizeEx()?;
///
/// let _lock = hfile.LockFile(0, total_size as _)?; // keep guard alive
///
/// // file read/write operations...
///
/// // UnlockFile() called automatically
/// # w::SysResult::Ok(())
/// ```
#[must_use]
fn LockFile(&self,
offset: u64,
num_bytes_to_lock: u64,
) -> SysResult<UnlockFileGuard<'_, Self>>
{
unsafe {
bool_to_sysresult(
ffi::LockFile(
self.ptr(),
LODWORD(offset),
HIDWORD(offset),
LODWORD(num_bytes_to_lock),
HIDWORD(num_bytes_to_lock),
),
).map(|_| UnlockFileGuard::new(self, offset, num_bytes_to_lock))
}
}
/// [`ReadFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-readfile)
/// function.
///
/// Reads at most `buffer.len()` bytes from the file, starting at the
/// current file pointer offset. Returns how many bytes were actually read.
/// The file pointer is then incremented by the number of bytes read.
///
/// Note that asynchronous reading – which use the
/// [`OVERLAPPED`](crate::OVERLAPPED) struct – is not currently supported by
/// this method, because the buffer must remain untouched until the async
/// operation is complete, thus making the method unsound.
fn ReadFile(&self, buffer: &mut [u8]) -> SysResult<u32> {
let mut bytes_read = u32::default();
bool_to_sysresult(
unsafe {
ffi::ReadFile(
self.ptr(),
buffer.as_mut_ptr() as _,
buffer.len() as _,
&mut bytes_read,
std::ptr::null_mut(),
)
},
).map(|_| bytes_read)
}
/// [`SetEndOfFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-setendoffile)
/// function.
fn SetEndOfFile(&self) -> SysResult<()> {
bool_to_sysresult(unsafe { ffi::SetEndOfFile(self.ptr()) })
}
/// [`SetFilePointerEx`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-setfilepointerex)
/// function.
fn SetFilePointerEx(&self,
distance_to_move: i64,
move_method: co::FILE_STARTING_POINT,
) -> SysResult<i64>
{
let mut new_offset = i64::default();
bool_to_sysresult(
unsafe {
ffi::SetFilePointerEx(
self.ptr(),
distance_to_move,
&mut new_offset,
move_method.raw(),
)
},
).map(|_| new_offset)
}
/// [`SetFileTime`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-setfiletime)
/// function.
fn SetFileTime(&self,
creation_time: Option<&FILETIME>,
last_access_time: Option<&FILETIME>,
last_write_time: Option<&FILETIME>,
) -> SysResult<()>
{
bool_to_sysresult(
unsafe {
ffi::SetFileTime(
self.ptr(),
creation_time.map_or(std::ptr::null(), |p| p as *const _ as _),
last_access_time.map_or(std::ptr::null(), |p| p as *const _ as _),
last_write_time.map_or(std::ptr::null(), |p| p as *const _ as _),
)
},
)
}
/// [`WriteFile`](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-writefile)
/// function.
///
/// Returns the number of bytes written.
///
/// Note that asynchronous writing – which use the
/// [`OVERLAPPED`](crate::OVERLAPPED) struct – is not currently supported by
/// this method, because the buffer must remain untouched until the async
/// operation is complete, thus making the method unsound.
fn WriteFile(&self, data: &[u8]) -> SysResult<u32> {
let mut bytes_written = u32::default();
bool_to_sysresult(
unsafe {
ffi::WriteFile(
self.ptr(),
vec_ptr(data) as _,
data.len() as _,
&mut bytes_written,
std::ptr::null_mut(),
)
},
).map(|_| bytes_written)
}
}